Introduction

Welcome to the Alaunus API! You can use our API to access Alaunus API endpoints, which can get information on stuff in our database.

We have language bindings in Shell, Ruby, and Python! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

To authorize, use this code:

require 'Kittn'

api = Kittn::APIClient.authorize!('meowmeowmeow')

import kittn

api = kittn.authorize('meowmeowmeow')

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
  -H "Authorization: meowmeowmeow"

const kittn = require('kittn');

let api = kittn.authorize('meowmeowmeow');

Make sure to replace meowmeowmeow with your API key.

Kittn uses API keys to allow access to the API. You can register a new Kittn API key at our developer portal.

Kittn expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: meowmeowmeow

You must replace meowmeowmeow with your personal API key.

Accounts

The accounts object

Attributes:

Attribute

Type

Description

_created_date

This contains the created date

_id

This contains the account id number

active

integer

If the account is active or not

billing_settings

subdocument

Contains all the billing settings, like how is the billing going to happen, what happens with late checkouts and others

candidate_settings

subdocument

Contains all information on employee candidates, like stage, description, hr information and more

string

Retrieves the email data

emergency_phones

subdocuments

Contains the emergency phones and its informations

ext_id

string

Contains the external id

hst_number

string

Contains the HST number

invoice_settings

subdocument

Contains all the invoice settings, like the sales rep for example.

locations

subdocuments

Location info, like address and geolocation

logo

file

Company logo

name

subdocument

Name of the company

payroll_settings

subdocument

Contains all the payroll settings, like the type of payroll, the period and others

policy

file

The company's policy

role_settings

subdocument

This contains the settings for each role inside the company

roles

subdocuments

Contains information about the roles, like for example the type, color and all the permissions

sales_reps

subdocuments

Contains information on the sales reps, like his or hers name, office, nickname and others

scheduler_settings

subdocument

Contains all the scheduler settings, like duration and permissions for example

services

subdocuments

Contains the services and its informations, like its code, description, pay rate and others

settings

subdocument

Contains settings like the timezone, currency used, country, language and others

taxes

subdocuments

Contains the taxes info, like the amount and its label

telephony

subdocument

Contains the telephony information, like the authentication token, errors and others

terms

subdocuments

Contains the company's terms

visit_settings

subdocument

Contains all the visit settings, like punchcards, gps, overrides and telephony

website

string

Contains the company's website

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Candidates

The candidates object

Attributes:

Attribute

Type

Description

_deleted_dates

subdocuments

Contains the date in which the candidate was deleted and its reasons

_hired

boolean

If candidate was hired or not

_hired_date

datetime

Date in which the candidate was hired

_hired_user

User that hired

availability

subdocument

What are the days and hours that the candidate is available during the week

candidate_notes

subdocuments

Notes on the candidate

candidate_status

What is the status of the candidate, applied, phone screened, selected for interview, interviewd or hired

certifications

subdocuments

What are the certifications of the candidate

cleaning_skill

How are the cleaning skills of the candidate

cooking_skill

How are the cooking skills of the candidate

cover_letter

string

Candidate's cover letter

criminal_offender

boolean

If the candidate was a criminal offender

criminal_offender_reason

string

In case the candidate was a criminal offender, what was the reason

date_of_birth

date

Contains the date of birth of the candidate

drivers_licence

Contains information on the candidate's drivers licence, if the candidate has one or not and others

education_level

This contains the level of education of the candidate

string

Contains the email of the candidate

employment_history

subdocuments

This contains the employment history of the candidate, previous jobs, duration and etc

experience_num_of_years

How many years of experiece the candidate has

experience_with_ages

subdocument

Information on which range of ages the candidate has experience with

ext_id

string

Contains the external id

gender

Contains the gender of the candidate

has_pets

boolean

If the candidate is okay with pets

is_smoker

boolean

If the candidate is okay with smokers

languages

subdocuments

Contains the languages spoken by the candidate and which one is the primary language

living_status

Living status of the candidate

locations

subdocuments

Location info, like address and geolocation

manager

Manager info

name

subdocument

Name of the candidate

nearest_intersection

string

The nearest intersection to the candidate

phones

subdocuments

Information on the candidate's phones, like numbers and types

rating

integer

Contains the rating on the candidate

resume

string

Candidate's resume

salary_expectations

subdocument

What are the salary expectations of the candidate

skills

subdocuments

What are the candidate's skills

source

Candidate's source

swimming_skill

How are the swimming skills of the candidate

transportation

Contains the method of transportation of the candidate, if it is by bus or car for example

travel_passport

boolean

If the candidate has a valid travel passport or not

type_of_pets

If the candidate is okay with pets, which kind of pets

us_visa

boolean

If the candidate has a US travel visa or not

will_travel

boolean

If the candidate is willing to travel or not

work_permit

What is the type of work permit of the candidate

work_status

subdocument

Contains information on the candidate work status, if it is full time, part time, temp or on call

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Clients

The clients object

Attributes:

Attribute

Type

Description

accounting_id

string

Contains the accounting id

color

string

Color of the tag

company

subdocument

Company's name and website

contact

subdocument

Information on the client, like name, phones and gender

contact_type

Type of client, if it is company or person

string

Contains the email of the client

employees

subdocuments

Contains information on the employees, like their names, offices, emails and others

ext_id

string

Contains the external id

locations

subdocuments

Location info, like address and geolocation

type

Type of client, if it is company or person

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Contacts

The contacts object

Attributes:

Attribute

Type

Description

_type

Type of contact, if it is company or person

accounting_id

string

Contains the accounting id

company

subdocument

Company's name and website

contact

subdocument

Information on the client, like name, phones and gender

string

Contains the email of the contact

ext_id

string

Contains the external id

fax

subdocument

Contains the fax number of the contact

locations

subdocuments

Location info, like address and geolocation

notes

string

Notes on the contact

photo

file

Photo of the contact

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Conversations

The conversations object

Attributes:

Attribute

Type

Description

from

subdocument

Form whom the message comes

messages

subdocuments

The message info

subdocuments

To whom the message will be sent

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Events

The events object

Attributes:

Attribute

Type

Description

_created_user

Information on the user that created this event

_group

Group of events

_last_updated_date

datetime

When was the event last updated

_last_updated_user

Which user last updated the event

attendees

subdocuments

Information on who are the attendees on the event, like name, pay_rate and others

billing

subdocument

Information on the billing, like billing period, currency, payment method and others

duration

float

Information on the duration of the event

end

datetime

When does the event ends

expectation

subdocument

Expectation on the bill amount

location

subdocument

Location where the event is going to start with information like address and geolocation

location_end

subdocument

Location where the event is going to end with information like address and geolocation

notes

string

Notes on the event

patient

subdocument

Information on the patient

service

subdocument

Information on the services that apply for this event, like pay rate and others

start

datetime

Start of the event

stat_holiday

boolean

If it was on a holiday

status

Status of the event

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Eventsgroups

The eventsgroups object

Attributes:

Attribute

Type

Description

bymonthday

array

If the event is grouped by month

byweekday

array

If the event is grouped by week

count

integer

How many times the event happens

dtstart

date

Date the event group started

end

datetime

Dante the event group ends

ends

subdocument

The ends of the event

events

array

All the events in that group of events

freq

string

The frequency in which the event repeats

interval

integer

The interval in which the event happens

start

datetime

When the group of events start

until

datetime

Until when the group of events is supposed to happen

wkst

string

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Files

The files object

Attributes:

Attribute

Type

Description

_uploaded_date

datetime

Date in which the file was uploaded

checksum

string

Checksum number in order to detect errors on the file

content_type

string

Type of the content of the file

file

string

The file

name

string

Name of the file

notes

string

Notes on the file

type

Type of the file

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Invoices

The invoices object

Attributes:

Attribute

Type

Description

_closed

boolean

If the invoice is closed or not

_closed_date

datetime

Date in which the invoice was closed in case it was closed

_closed_user

User that closed the invoice

account

subdocument

Information on the account, like name, location and website

amount_due

float

How much is due to be paid

amount_paid

float

How much was paid

billing_period

subdocument

What is the billing period

billing_period_end_date

date

Date in which the billing period ends

billing_period_start_date

date

Date in which the billing period starts

cc_invoice

subdocument

Credit card invoice

claim_number

string

Contains the number of the claim

client

subdocument

Information on the client, like for example type, id, email, phone and others

currency

Currency used

due_date

date

When it is due

footer_message

string

Message on the footer

from_email

string

Email used for the invoice

header_message

string

Message on the header

hst_number

string

Contains the HST number

invoice_date

date

Date of the invoice

invoice_type

Type of the invoice

legal_rep

string

Information on the legal rep

loss_date

date

Date of loss

method

Method used for the invoice

notes

string

Notes on the invoice

number

string

Invoice number

patient

subdocument

Information on the patient, with email, name, location, phone and others

payment_method

Method used for the payment

punchcards

subdocuments

Punchcards information, with bill and others

referred_by

subdocument

By whom it was referred

sales_rep

subdocument

Contains information on the sales rep, like his or hers name, office, nickname and others

services

subdocuments

Contains the services and its informations, like its code, description, pay rate and others

status

Status of the invoice

subtotal

float

Invoice's subtotal

tax_total

float

Total taxes

taxes

subdocuments

Contains the taxes info, like the amount and its label

template

Invoice template

term

subdocument

Invoice's term

total

float

Invoice's total

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Patients

The patients object

Attributes:

Attribute

Type

Description

_account

_deleted_dates

subdocuments

Contains the date in which the patient was deleted and its reasons

accounting_id

string

Contains the accounting id

billing

subdocuments

Contains all the billing info, like how is the billing period and others

case_coordinator

Information on the case coordinator for that patient

ccac

subdocument

Credit card account of the patient

chart_id

string

Patient's chart ID

checklist

subdocument

Patient's checklist

cleaning_skill

What are the cleaning skills the patient is expecting

contacts

subdocuments

Emergency contacts with phone number and etc

cooking_skill

What are the cooking skills the patient is expecting

date_of_birth

date

Date of birth of the patient

education_level

This contains the level of education the patient expects

string

Contains the email of the patient

ethnicity

Ethnicity of the patient

experience_num_of_years

Number of years of experience expected by the patient

experience_with_ages

subdocument

Experience with range of years expected

files

subdocuments

Files about the patient

gender

Gender of the patient

general_notes

string

Notes on the patient

has_pets

boolean

If the patient has pets

important_notes

string

Notes on the patient

is_smoker

boolean

If the patient is a smoker

languages

subdocuments

Languages spoken by the patient

legal_rep

string

Information on the legal rep

living_status

Living status of the patient

locations

subdocuments

Location info, like address and geolocation

major_intersection

string

The major intersection to the candidate

marital_status

Marital status of the patient

name

subdocument

Name of the patient

notes

subdocuments

Notes on the patient

phones

subdocuments

All patient's phone numbers and its types

photo

file

Photo of the patient

problems

subdocuments

Patient's problems

referred_by

Who referred that patient

religion

Patient's religion

salary_expectations

subdocument

How much is the salary

service_date

subdocument

Service date range

services

subdocuments

All the services necessary by the patient

ssn

string

SSN nuber

ssn_expiry_date

date

Date in which the ssn expiry

status

Patient's status

swimming_skill

What are the swimming skills the patient is expecting

transportation

What kind of transportation is the patient expecting

travel_passport

boolean

If patient requires a valid travel passport

type_of_pets

If the patient has pets, what are the kind of pets

us_visa

boolean

If patient requires a valid US visa

user_education_level

Education level required by the patient

will_travel

boolean

If patient will be travelling

work_status

subdocument

Work status required by tge patient

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Patientsprogressnotes

The patientsprogressnotes object

Attributes:

Attribute

Type

Description

_created_date

Date in which the progress note was created

_created_user

Which user created the progress note

_deleted

If it was deleted

_last_updated_date

datetime

Last date note was updated

_last_updated_user

Last user that updated the note

approval

subdocument

If it was approved and the date

invoice_to

subdocument

For whom is the invoice

note

string

The note itself

patient

Patient ID

patient_service

Patient's services

priority

The priority of the note

private

boolean

If the note is private or not

referrer

Who referred

service

The service that was tagged

Payments

The payments object

Attributes:

Attribute

Type

Description

amount

float

Amount paid

client

Who made the payment

date

datetime

Date of the payment

invoice

Invoice for the payment

notes

string

Notes on the payment

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Payrolls

The payrolls object

Attributes:

Attribute

Type

Description

_closed

boolean

If payroll was closed or not

_closed_date

datetime

Date when payroll was closed

_closed_user

User that closed the payroll

end

date

End date

period_extra

integer

Extra period

period_type

Type of the period

start

date

Start date

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Payrollsusers

The payrollsusers object

Attributes:

Attribute

Type

Description

_created_date

The date it was created

_created_user

The user that created it

adjustments

subdocuments

ADjustments information

payroll

Payroll information

punchcards

array

Punchcards information, with bill and others

user

subdocument

User information, like name, nickname and others

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Punchcards

The punchcards object

Attributes:

Attribute

Type

Description

_event

subdocument

Punchcard's event

actual

subdocument

Actual information, with actual date and others

bill

subdocument

Punchcard's bill

billing

subdocument

All billing info on the punchcards

event

Punchcard's event ID

invoice

subdocument

Punchcard's invoice

location

subdocument

Punchcard's location

location_end

subdocument

The end location for that punchcard

patient

subdocument

Patient on the punchcard

pay

subdocument

All the paying information on that punchcard

payroll

subdocument

Payroll on the punchcard

service

subdocument

Information about the service on that punchcard

stat_holiday

boolean

If it is or not an statutory holiday

user

subdocument

The user on that punchcard and his or hers information

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Skills

The skills object

Attributes:

Attribute

Type

Description

color

string

Color of the skill

description

string

Description of the skill

title

string

Title of the skill

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Users

The users object

Attributes:

Attribute

Type

Description

_candidate

Contains the candidate id

_deleted

User was deleted

_deleted_dates

subdocuments

Contains the date in which the user was deleted and its reasons

_setup_date

datetime

Date in which the user was set

_suspended

boolean

User was suspended

_suspended_date

datetime

Contains the date in which the user was suspended

_suspended_user

Who suspended that user

accounting_id

string

This contains the accounting id number

availability

subdocument

Days and hours in which the user is available

certifications

subdocuments

Certifications of the user, like school, university and etc

cleaning_skill

How are the cleaning skills of the user

cooking_skill

How are the cooking skills of the user

criminal_offender

boolean

If the user was a criminal offender

criminal_offender_reason

string

In case the user was a criminal offender, what was the reason

date_of_birth

date

Date of birth of the user

drivers_licence

Contains information on the user's drivers licence, if the user has one or not and others

education_level

This contains the level of education of the user

string

Contains the user email

employment_history

subdocuments

This contains the employment history of the user, previous jobs, duration and etc

experience_num_of_years

How many years of experiece the user has

experience_with_ages

subdocument

Information on which range of ages the user has experience with

ext_id

string

Contains the user external ID

files

subdocuments

Any files on the user

gender

User's gender

has_pets

boolean

If the user is okay with pets

invited_date

datetime

Date in which the user was invited

is_setup

boolean

If the user is set up

is_smoker

boolean

If the user is okay with smokers

languages

subdocuments

Languages spoken by the user, with information on which one is his or hers primary language

last_login_date

datetime

Last time user logged in

living_status

Living status of the user

locations

subdocuments

Location info, like address and geolocation

manager

Manager info

name

subdocument

Name of the user

nearest_intersection

string

The nearest intersection to the user

phones

subdocuments

Information on the user's phones, like numbers and types

photo

file

User's photo

role

Role of the user

role_type

Type of role

salary_expectations

subdocument

What are the salary expectations of the user

services

subdocuments

Services provided by the user

skills

subdocuments

What are the user's skills

source

User's source

ssn

string

SSN number

ssn_expiry_date

date

SSN expiry date

start_date

date

Date in which the user started

swimming_skill

How are the swimming skills of the user

timezone

Timezone of the user

transportation

Contains the method of transportation of the user, if it is by bus or car for example

travel_passport

boolean

If the user has a valid travel passport or not

type_of_pets

If the user is okay with pets, which kind of pets

us_visa

boolean

If the user has a US travel visa or not

will_travel

boolean

If the user is willing to travel or not

work_permit

What is the type of work permit of the user

work_status

subdocument

Contains information on the user work status, if it is full time, part time, temp or on call

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Usersnotes

The usersnotes object

Attributes:

Attribute

Type

Description

_created_date

Date in which the note was created

_created_user

Which user created the note

_deleted

If it was deleted

last_updated_date

datetime

Last date note was updated

last_updated_user

Last user that updated the note

note

string

The note itself

priority

The priority of the note

title

string

The title of the note

user

User ID

require 'test'
api = Test::APIClient.authorize!('key')
api.tests.get

dsja javascript
dsja javascript
print 'Hello, world!'
sads shell

import test
 
api = test.authorize('key')
api.test.get()

curl 'http://example.com/api/test'
  -H 'Authorization: key'

Introduction

Authentication

Accounts

The accounts object

Attributes:

Candidates

The candidates object

Attributes:

Clients

The clients object

Attributes:

Contacts

The contacts object

Attributes:

Conversations

The conversations object

Attributes:

Events

The events object

Attributes:

Eventsgroups

The eventsgroups object

Attributes:

Files

The files object

Attributes:

Invoices

The invoices object

Attributes:

Patients

The patients object

Attributes:

Patientsprogressnotes

The patientsprogressnotes object

Attributes:

Payments

The payments object

Attributes:

Payrolls

The payrolls object

Attributes:

Payrollsusers

The payrollsusers object

Attributes:

Punchcards

The punchcards object

Attributes:

Skills

The skills object

Attributes:

Tags

The tags object

Attributes:

Users

The users object

Attributes:

Usersnotes

The usersnotes object

Attributes: